Allow code blocks to import code from files or URLs #4236
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@Blargian is attempting to deploy a commit to the ClickHouse Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
gingerwizard
reviewed
Aug 7, 2025
Blargian
changed the title
Blargian
changed the title
|
CC @mshustov, I remember you mentioned it would be nice to test code snippets in the docs. This change will allow you to import code into docs from integrations repos using |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Per request, code for code blocks should be able to be imported from files or URLs.
This change will allow the user to specify
file=orurl=on code snippets. For example:file=code_snippets/ClickStack/config-unstructured-logs-with-processor.yamlurl=https://raw.githubusercontent.com/ClickHouse/clickhouse-connect/refs/heads/main/examples/pandas_examples.pyThe code from the file or URL will be inserted as text into the code block in the markdown when
yarn buildis run. The changes show as diffs (i.e the markdown files are updated with the changes) so we can commit the latest change permanently for human or LLM readers of the markdown. The advantage of this is that we can test these snippets externally and pull them from other repositories.Checklist